ValidatedIngredient
A validated provider of Ingredient
This does not store an ingredient, it stores an IngredientProvider, which lazily generates the ingredient only when requested.
Author
fzzyhmstrs
Since
0.2.0, marked final 0.6.0
Samples
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedIngredient
import me.fzzyhmstrs.fzzy_config.validation.minecraft.ValidatedTagKey
import net.minecraft.recipe.Ingredient
import net.minecraft.registry.tag.BlockTags
import net.minecraft.registry.tag.ItemTags
import net.minecraft.util.Identifier
fun main() {
//sampleStart
// A validated Ingredient for a single item
val validatedIngredientItem = ValidatedIngredient(Identifier("oak_log"))
// A validated ingredient accepting a set of items
val validatedIngredientList = ValidatedIngredient(setOf(Identifier("oak_log"), Identifier("dark_oak_log")))
// A validated ingredient utilizing a tag
val validatedIngredientTag = ValidatedIngredient(ItemTags.LOGS_THAT_BURN)
//get the ingredient from the holder for use in Materials etc
val validatedIngredientIngredient: Ingredient = validatedIngredientItem.toIngredient()
//fields and sections have lang keys based on their "location" in the Config class graph.
//Lange key composition is as follows
//1. the namespace of the config id: (my_mod)
//2. the path of the config id: (my_mod.my_config)
//3. any parent ConfigSection field names as declared in-code: (my_mod.my_config.subSection)
//4. the setting field name as declared in-code: (my_mod.my_config.subSection.fieldName)
val fieldLang = """
{
"_comment1": "the lang for an example 'fieldName' setting in a config inside section 'subSection'",
"my_mod.my_config.subSection.fieldName": "Very Important Setting",
"my_mod.my_config.subSection.fieldName.desc": "This very important setting is used in this very important way."
}
"""
//sampleEnd
}Constructors
A validated provider of Ingredient
A validated provider of Ingredient
A validated provider of Ingredient
Types
Functions
updates the wrapped value. NOTE: this method will push updates to an UpdateManager, if any. For in-game updating consider validateAndSet
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.
Provides a Codec representing the value type of this validation, backed by the validators within as applicable
Copies the stored value and returns it.
Copies the provided input as deeply as possible. For immutables like numbers and booleans, this will simply return the input
Corrects an attempted input, as possible. When correction isn't possible or deterministic, simply validate the entry the same way you would for EntryValidator
The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.
translation key of this Translatable's description. the "description" in-game, the descriptions Enchantment Descriptions adds to enchantment tooltips are a good example.
Specialized equals method for determining if a newly deserialized value is effectively equal to its old counterpart.
supplies the wrapped value
Provides this validations default value
Whether this Translatable has a valid description
Whether this Translatable has a valid translation
creates a deep copy of this ValidatedIngredient return ValidatedIngredient wrapping a deep copy of the currently stored ingredient provider as well as predicates, if any
Attaches a listener to this field. This listener will be called any time the field is written to ("set"). accept, validateAndSet, setAndUpdate and so on will all call the listener.
Maps this validation to a new convertible type. The default value will be applied from this delegates current storedValue
Maps this validation to a new convertible type.
Pairs this validation with another validation into one ValidatedPair
The translated Text description from the descriptionKey. Falls back to an empty string so no tooltip is rendered.
Called in the prepare stage of screen building to perform any necessary pre-entry-creation tasks.
Convert this field to a ValidatedCondition using the provided validation as a supplier. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied.
Convert this field to a ValidatedCondition using the provided scope with a default boolean provider. The provided condition (and any others you append) must pass for the stored value to be provided, otherwise the fallback will be supplied. The provided scope must point to a valid boolean config scope otherwise the initial condition will never pass.
Supplies the Ingredient from this ValidatedIngredients Provider
Wraps the provided values into a ValidatedList with this field as validation
Wraps the provided collection into a ValidatedList with this field as validation
Wraps the provided values into a ValidatedSet with this field as validation
Wraps the provided collection into a ValidatedSet with this field as validation
translation key of this Translatable. the "name" in-game
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.
Updates this ValidatedIngredient with a new multi-item Ingredient
Updates this ValidatedIngredient with a new tag Ingredient
Updates this ValidatedIngredient with a new single-item Ingredient
A setter method for the storedValue that first validates the value being set and then stores the post-validation result.
Validates an input per the provided validation type.
Builds a new ClickableWidget and applies a tooltip to it. This shouldn't need to be overridden in most cases